Skip to content

DOC-774 | New license management using credentials to activate deployments or generate license keys #843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Simran-B wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DOC-774 | New license management using credentials to activate deployments or generate license keys #843

Simran-B wants to merge 3 commits into from

Conversation

@Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Dec 2, 2025 •
edited by cursor bot
Loading

Description

Open tasks and questions:

  • Are there any new metrics or changes not yet mentioned, e.g. regarding the shorter expiration of licenses, like the web UI?
  • Do we already support a custom registry to pull the Data Platform images from instead of using a zipped platform package?
  • For Starter deployments, should we recommend not using -e ARANGO_LICENSE_KEY unless for e.g. air-gapped environments and link to the license management page for how to activate a deployment using the Platform CLI tool?
  • Do we issue licenses that are valid for more than 2 weeks for customers with air-gapped environments?

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 4.0:

Note

Documents new deployment ID endpoint, overhauls Enterprise license management (credentials-based activation/key generation), updates references/release notes, and adds a Data Platform installation guide with streamlined platform docs.

  • HTTP API (3.12 & 4.0):
    • Add GET /_admin/deployment/id endpoint docs with OpenAPI, examples, and permissions.
  • License Management:
    • Rewrite to credentials-based flow: add sections to activate deployments and generate license keys; rename to “Apply a license key”.
    • Update @arangodb/db-object references to “Apply a license key”.
    • Release notes: note deployment-bound licenses, new endpoint, and short-lived activations/keys.
  • Release Notes (3.12):
    • API Changes/Incompat/In What’s New: add “Deployment ID” and license management changes across 3.12 docs.
  • Arango Data Platform Docs:
    • Add new installation.md (on-prem setup via Kubernetes, Operator, CLI, license secret, package install).
    • Streamline _index.md (deployment options, aliases) and trim get-started.md to a stub; adjust release notes links/wording.

Written by Cursor Bugbot for commit 8b6fb74. This will update automatically on new commits. Configure here.

@Simran-B Simran-B added this to the 3.12.6 milestone Dec 2, 2025
@Simran-B Simran-B requested review from ajanikow and nerpaula December 2, 2025 09:41
@arangodb-docs-automation
Copy link
Contributor

arangodb-docs-automation bot commented Dec 2, 2025

Deploy Preview Available Via
https://deploy-preview-843--docs-hugo.netlify.app

@cla-bot cla-bot bot added the cla-signed label Dec 2, 2025
@Simran-B Simran-B self-assigned this Dec 2, 2025
@Simran-B
Add online installation page, temporary remove get started page
6f309b6 
The setup steps are moved to the installation page and the deployment options to the parent page
@Simran-B
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
8b6fb74 
…-774
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ajanikow ajanikow Awaiting requested review from ajanikow

@nerpaula nerpaula Awaiting requested review from nerpaula

At least 1 approving review is required to merge this pull request.

Assignees

@Simran-B Simran-B

Labels

cla-signed

Projects

None yet

Milestone

3.12.6

Development

Successfully merging this pull request may close these issues.

2 participants

@Simran-B